/*******************************************************************************
 * Copyright 2009, 2010 Innovation Gate GmbH. All Rights Reserved.
 * 
 * This file is part of the OpenWGA server platform.
 * 
 * OpenWGA is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * In addition, a special exception is granted by the copyright holders
 * of OpenWGA called "OpenWGA plugin exception". You should have received
 * a copy of this exception along with OpenWGA in file COPYING.
 * If not, see <http://www.openwga.com/gpl-plugin-exception>.
 * 
 * OpenWGA is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with OpenWGA in file COPYING.
 * If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/
package de.innovationgate.webgate.api;

/**
 * interface for mata converter implementations
 * converter implementations can be stored on the metaInfo of the metaData
 * setMetaData() of WGdocument calls the convert methods before setting the metadataValue
 * getMetaData() of WGdocument calls the convert methods before returning the metadataValue
 * in the backend 
 *
 *
 */
interface MetaConverter {
    
    /**
     * executes special conversions on the given value during setMetaData
     * @param the current document the meta belongs to
     * @param metaInfo MetaInfo of the corresponding metaData
     * @param value input value - value is != null
     * @return converted value to be stored in backend
     * @throws WGAPIException 
     */
    Object convert(WGDocument doc, MetaInfo metaInfo, Object value) throws WGAPIException;

}
